# SocketTask tap.connectSocket(Object object)

推荐使用 SocketTask 的方式去管理 webSocket 链接,每一条链路的生命周期都更加可控,同时存在多个 webSocket 的链接的情况下使用 tap 前缀的方法可能会带来一些和预期不一致的情况。

以 Promise 风格调用:不支持

相关文档: 网络使用说明、局域网通信

# 功能描述

创建一个 WebSocket 连接。

# 参数

# Object object

属性类型默认值必填说明
urlstring开发者服务器 wss 接口地址
headerObjectHTTP Header,Header 中不能设置 Referer
protocolsArray.<string>子协议数组
tcpNoDelaybooleanfalse建立 TCP 连接的时候的 TCP_NODELAY 设置
perMessageDeflatebooleanfalse是否开启压缩扩展
timeoutnumber超时时间,单位为毫秒
forceCellularNetworkbooleanfalse强制使用蜂窝网络发送请求
successfunction接口调用成功的回调函数
failfunction接口调用失败的回调函数
completefunction接口调用结束的回调函数(调用成功、失败都会执行)

# 返回值

# SocketTask

WebSocket 任务

# 并发数

  • 1.7.0 及以上版本,最多可以同时存在 5 个 WebSocket 连接。
  • 1.7.0 以下版本,一个小游戏同时只能有一个 WebSocket 连接,如果当前已存在一个 WebSocket 连接,会自动关闭该连接,并重新创建一个 WebSocket 连接。

# 示例代码

tap.connectSocket({
  url: 'wss://example.qq.com',
  header:{
    'content-type': 'application/json'
  }
})